-
Notifications
You must be signed in to change notification settings - Fork 34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a note on fig.mne.colorbar in the docs of plot_connectivity_circle #266
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks @ruuskas, looks good. For this one we'll wait to merge until the upstream change is in and we've formalized what the namespace structure will be like (so that we're certain that fig.mne.colorbar
is the correct way to access this)
Marking as "request changes" just as a reminder that we shouldn't merge yet.
I think the right approach in this case is to do |
I don't think we've made any progress on formalizing the One possible "shortcut" to preventing too much churn later would be to create separate namespaces for each plotting function, so, e.g.: |
Is it often the case that e.g. colorbars from multiple plotting functions co-exist inside the same |
True! I made a very small addition there. |
it's at least possible, as we have some plotting functions that can take a list of axes and use one of them for a colorbar. A maybe not-too-far-fetched example would be one or more scalp topographies combined with an epochs image plot. For journals that like large multi-panel "narrative" figures it seems (to me at least) not so far-fetched.
This certainly could lead to unnecessary complication (though I think not redundancy, strictly speaking). It's motivated by (1) not having the time to flesh out a full namespace for all our plotting functions right now, and (2) wanting to avoid changing the namespace later in a way that will require users to edit their scripts.
Agree that one function call yielding multiple colorbars should put them in a list. |
This is related to PR 13019 in MNE-Python and closes #262.
I also tried changing the example
mne_inverse_label_connectivity.py
to add an example use case. However, it appears that since the figure is rendered before theplot_connectivity_circle
function exits, changes made afterwards do not become visible in the figure unlessfig.show()
is called, which leads to showing the figure twice. Workarounds to prevent this of course exist but might clutter the example unnecessarily. Thoughts?